<!DOCTYPE html>
<html lang="en-us">
  <head>

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    
<meta charset="UTF-8">
<title>Get follower stats API | Elasticsearch Guide [7.7] | Elastic</title>
<link rel="home" href="index.html" title="Elasticsearch Guide [7.7]">
<link rel="up" href="ccr-apis.html" title="Cross-cluster replication APIs">
<link rel="prev" href="ccr-post-forget-follower.html" title="Forget follower API">
<link rel="next" href="ccr-get-follow-info.html" title="Get follower info API">
<meta name="DC.type" content="Learn/Docs/Elasticsearch/Reference/7.7">
<meta name="DC.subject" content="Elasticsearch">
<meta name="DC.identifier" content="7.7">
<meta name="robots" content="noindex,nofollow">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script src="https://cdn.optimizely.com/js/18132920325.js"></script>
    <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
    <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
    <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
    <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
    <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
    <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
    <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
    <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
    <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
    <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
    <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
    <link rel="manifest" href="/manifest.json">
    <meta name="apple-mobile-web-app-title" content="Elastic">
    <meta name="application-name" content="Elastic">
    <meta name="msapplication-TileColor" content="#ffffff">
    <meta name="msapplication-TileImage" content="/mstile-144x144.png">
    <meta name="theme-color" content="#ffffff">
    <meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd">
    <meta name="yandex-verification" content="d8a47e95d0972434">
    <meta name="localized" content="true">
    <meta name="st:robots" content="follow,index">
    <meta property="og:image" content="https://www.elastic.co/static/images/elastic-logo-200.png">
    <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
    <link rel="icon" href="/favicon.ico" type="image/x-icon">
    <link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
    <link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
    <link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
    <link rel="stylesheet" type="text/css" href="/guide/static/styles.css">
  </head>

  <!--© 2015-2021 Elasticsearch B.V. Copying, publishing and/or distributing without written permission is strictly prohibited.-->

  <body>
    <!-- Google Tag Manager -->
    <script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
    <!-- End Google Tag Manager -->

    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'UA-12395217-16');
    </script>

    <!--BEGIN QUALTRICS WEBSITE FEEDBACK SNIPPET-->
    <script type="text/javascript">
      (function(){var g=function(e,h,f,g){
      this.get=function(a){for(var a=a+"=",c=document.cookie.split(";"),b=0,e=c.length;b<e;b++){for(var d=c[b];" "==d.charAt(0);)d=d.substring(1,d.length);if(0==d.indexOf(a))return d.substring(a.length,d.length)}return null};
      this.set=function(a,c){var b="",b=new Date;b.setTime(b.getTime()+6048E5);b="; expires="+b.toGMTString();document.cookie=a+"="+c+b+"; path=/; "};
      this.check=function(){var a=this.get(f);if(a)a=a.split(":");else if(100!=e)"v"==h&&(e=Math.random()>=e/100?0:100),a=[h,e,0],this.set(f,a.join(":"));else return!0;var c=a[1];if(100==c)return!0;switch(a[0]){case "v":return!1;case "r":return c=a[2]%Math.floor(100/c),a[2]++,this.set(f,a.join(":")),!c}return!0};
      this.go=function(){if(this.check()){var a=document.createElement("script");a.type="text/javascript";a.src=g;document.body&&document.body.appendChild(a)}};
      this.start=function(){var a=this;window.addEventListener?window.addEventListener("load",function(){a.go()},!1):window.attachEvent&&window.attachEvent("onload",function(){a.go()})}};
      try{(new g(100,"r","QSI_S_ZN_emkP0oSe9Qrn7kF","https://znemkp0ose9qrn7kf-elastic.siteintercept.qualtrics.com/WRSiteInterceptEngine/?Q_ZID=ZN_emkP0oSe9Qrn7kF")).start()}catch(i){}})();
    </script><div id="ZN_emkP0oSe9Qrn7kF"><!--DO NOT REMOVE-CONTENTS PLACED HERE--></div>
    <!--END WEBSITE FEEDBACK SNIPPET-->

    <div id="elastic-nav" style="display:none;"></div>
    <script src="https://www.elastic.co/elastic-nav.js"></script>

    <!-- Subnav -->
    <div>
      <div>
        <div class="tertiary-nav d-none d-md-block">
          <div class="container">
            <div class="p-t-b-15 d-flex justify-content-between nav-container">
              <div class="breadcrum-wrapper"><span><a href="/guide/" style="font-size: 14px; font-weight: 600; color: #000;">Docs</a></span></div>
            </div>
          </div>
        </div>
      </div>
    </div>

    <div class="main-container">
      <section id="content">
        <div class="content-wrapper">

          <section id="guide" lang="en">
            <div class="container">
              <div class="row">
                <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                  <!-- start body -->
                  <div class="page_header">
<strong>IMPORTANT</strong>: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="rest-apis.html">REST APIs</a></span>
»
<span class="breadcrumb-link"><a href="ccr-apis.html">Cross-cluster replication APIs</a></span>
»
<span class="breadcrumb-node">Get follower stats API</span>
</div>
<div class="navheader">
<span class="prev">
<a href="ccr-post-forget-follower.html">« Forget follower API</a>
</span>
<span class="next">
<a href="ccr-get-follow-info.html">Get follower info API »</a>
</span>
</div>
<div class="section xpack">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="ccr-get-follow-stats"></a>Get follower stats API<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc">edit</a><a class="xpack_tag" href="/subscriptions"></a>
</h2>
</div></div></div>

<p>Get follower stats.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-stats-request"></a>Request<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /&lt;index&gt;/_ccr/stats</pre>
</div>
<div class="console_widget" data-snippet="snippets/1438.console"></div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-stats-prereqs"></a>Prerequisites<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="ulist itemizedlist">
<ul class="itemizedlist">
<li class="listitem">
If the Elasticsearch security features are enabled, you must have <code class="literal">monitor</code> cluster
privileges on the cluster that contains the follower index. For more information,
see <a class="xref" href="security-privileges.html" title="Security privileges">Security privileges</a>.
</li>
</ul>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-stats-desc"></a>Description<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This API gets follower stats. This API will return shard-level stats about the
following tasks associated with each shard for the specified indices.</p>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-stats-path-parms"></a>Path parameters<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">&lt;index&gt;</code>
</span>
</dt>
<dd>
(Required, string) A comma-delimited list of index patterns.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-stats-response-body"></a>Response body<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This API returns the following information:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">indices</code>
</span>
</dt>
<dd>
(array) An array of follower index statistics.
</dd>
</dl>
</div>
<p>The <code class="literal">indices</code> array consists of objects containing two fields:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">indices[].index</code>
</span>
</dt>
<dd>
(string) The name of the follower index.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards</code>
</span>
</dt>
<dd>
(array) An array of shard-level following task statistics.
</dd>
</dl>
</div>
<p>The <code class="literal">shards</code> array consists of objects containing the following fields:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">indices[].shards[].remote_cluster</code>
</span>
</dt>
<dd>
(string) The <a class="xref" href="modules-remote-clusters.html" title="Remote clusters">remote cluster</a> containing the leader
index.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].leader_index</code>
</span>
</dt>
<dd>
(string) The name of the index in the leader cluster being followed.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].follower_index</code>
</span>
</dt>
<dd>
(string) The name of the follower index.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].shard_id</code>
</span>
</dt>
<dd>
(integer) The numerical shard ID, with values from 0 to one less than the
number of replicas.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].leader_global_checkpoint</code>
</span>
</dt>
<dd>
(long) The current global checkpoint on the leader known to the follower task.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].leader_max_seq_no</code>
</span>
</dt>
<dd>
(long) The current maximum sequence number on the leader known to the follower
task.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].follower_global_checkpoint</code>
</span>
</dt>
<dd>
(long) The current global checkpoint on the follower. The difference between the
<code class="literal">leader_global_checkpoint</code> and the <code class="literal">follower_global_checkpoint</code> is an
indication of how much the follower is lagging the leader.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].follower_max_seq_no</code>
</span>
</dt>
<dd>
(long) The current maximum sequence number on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].last_requested_seq_no</code>
</span>
</dt>
<dd>
(long) The starting sequence number of the last batch of operations requested
from the leader.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].outstanding_read_requests</code>
</span>
</dt>
<dd>
(integer) The number of active read requests from the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].outstanding_write_requests</code>
</span>
</dt>
<dd>
(integer) The number of active bulk write requests on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].write_buffer_operation_count</code>
</span>
</dt>
<dd>
(integer) The number of write operations queued on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].follower_mapping_version</code>
</span>
</dt>
<dd>
(long) The mapping version the follower is synced up to.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].follower_settings_version</code>
</span>
</dt>
<dd>
(long) The index settings version the follower is synced up to.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].follower_aliases_version</code>
</span>
</dt>
<dd>
(long) The index aliases version the follower is synced up to.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].total_read_time_millis</code>
</span>
</dt>
<dd>
(long) The total time reads were outstanding, measured from the time a read
was sent to the leader to the time a reply was returned to the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].total_read_remote_exec_time_millis</code>
</span>
</dt>
<dd>
(long) The total time reads spent executing on the remote cluster.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].successful_read_requests</code>
</span>
</dt>
<dd>
(long) The number of successful fetches.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].failed_read_requests</code>
</span>
</dt>
<dd>
(long) The number of failed reads.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].operations_read</code>
</span>
</dt>
<dd>
(long) The total number of operations read from the leader.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].bytes_read</code>
</span>
</dt>
<dd>
<p>
(long) The total of transferred bytes read from the leader.
</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>This is only an estimate and does not account for compression if enabled.</p>
</div>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].total_write_time_millis</code>
</span>
</dt>
<dd>
(long) The total time spent writing on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].write_buffer_size_in_bytes</code>
</span>
</dt>
<dd>
(long) The total number of bytes of operations currently queued for writing.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].successful_write_requests</code>
</span>
</dt>
<dd>
(long) The number of bulk write requests executed on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].failed_write_requests</code>
</span>
</dt>
<dd>
(long) The number of failed bulk write requests executed on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].operations_written</code>
</span>
</dt>
<dd>
(long) The number of operations written on the follower.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].read_exceptions</code>
</span>
</dt>
<dd>
(array) An array of objects representing failed reads.
</dd>
</dl>
</div>
<p>The <code class="literal">read_exceptions</code> array consists of objects containing the following
fields:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">indices[].shards[].read_exceptions[].from_seq_no</code>
</span>
</dt>
<dd>
(long) The starting sequence number of the batch requested from the leader.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].read_exceptions[].retries</code>
</span>
</dt>
<dd>
(integer) The number of times the batch has been retried.
</dd>
<dt>
<span class="term">
<code class="literal">indices[].shards[].read_exceptions[].exception</code>
</span>
</dt>
<dd>
(object) Represents the exception that caused the read to fail.
</dd>
</dl>
</div>
<p>Continuing with the fields from <code class="literal">shards</code>:</p>
<div class="variablelist">
<dl class="variablelist">
<dt>
<span class="term">
<code class="literal">indices[].shards[].time_since_last_read_millis</code>
</span>
</dt>
<dd>
<p>
(long) The number of milliseconds since a read request was sent to the leader.
</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>When the follower is caught up to the leader, this number will
  increase up to the configured <code class="literal">read_poll_timeout</code> at which point another read
  request will be sent to the leader.</p>
</div>
</div>
</dd>
<dt>
<span class="term">
<code class="literal">indices[].fatal_exception</code>
</span>
</dt>
<dd>
(object) An object representing a fatal exception that cancelled the following
task. In this situation, the following task must be resumed manually with the
<a class="xref" href="ccr-post-resume-follow.html" title="Resume follower API">resume follower API</a>.
</dd>
</dl>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="ccr-get-follow-stats-examples"></a>Examples<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/docs/reference/ccr/apis/follow/get-follow-stats.asciidoc">edit</a>
</h3>
</div></div></div>
<p>This example retrieves follower stats:</p>
<div class="pre_wrapper lang-console">
<pre class="programlisting prettyprint lang-console">GET /follower_index/_ccr/stats</pre>
</div>
<div class="console_widget" data-snippet="snippets/1439.console"></div>
<p>The API returns the following results:</p>
<div class="pre_wrapper lang-console-result">
<pre class="programlisting prettyprint lang-console-result">{
  "indices" : [
    {
      "index" : "follower_index",
      "shards" : [
        {
          "remote_cluster" : "remote_cluster",
          "leader_index" : "leader_index",
          "follower_index" : "follower_index",
          "shard_id" : 0,
          "leader_global_checkpoint" : 1024,
          "leader_max_seq_no" : 1536,
          "follower_global_checkpoint" : 768,
          "follower_max_seq_no" : 896,
          "last_requested_seq_no" : 897,
          "outstanding_read_requests" : 8,
          "outstanding_write_requests" : 2,
          "write_buffer_operation_count" : 64,
          "follower_mapping_version" : 4,
          "follower_settings_version" : 2,
          "follower_aliases_version" : 8,
          "total_read_time_millis" : 32768,
          "total_read_remote_exec_time_millis" : 16384,
          "successful_read_requests" : 32,
          "failed_read_requests" : 0,
          "operations_read" : 896,
          "bytes_read" : 32768,
          "total_write_time_millis" : 16384,
          "write_buffer_size_in_bytes" : 1536,
          "successful_write_requests" : 16,
          "failed_write_requests" : 0,
          "operations_written" : 832,
          "read_exceptions" : [ ],
          "time_since_last_read_millis" : 8
        }
      ]
    }
  ]
}</pre>
</div>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="ccr-post-forget-follower.html">« Forget follower API</a>
</span>
<span class="next">
<a href="ccr-get-follow-info.html">Get follower info API »</a>
</span>
</div>
</div>

                  <!-- end body -->
                </div>
                <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                  <div id="rtpcontainer" style="display: block;">
                    <div class="mktg-promo">
                      <h3>Most Popular</h3>
                      <ul class="icons">
                        <li class="icon-elasticsearch-white"><a href="https://www.elastic.co/webinars/getting-started-elasticsearch?baymax=default&amp;elektra=docs&amp;storm=top-video">Get Started with Elasticsearch: Video</a></li>
                        <li class="icon-kibana-white"><a href="https://www.elastic.co/webinars/getting-started-kibana?baymax=default&amp;elektra=docs&amp;storm=top-video">Intro to Kibana: Video</a></li>
                        <li class="icon-logstash-white"><a href="https://www.elastic.co/webinars/introduction-elk-stack?baymax=default&amp;elektra=docs&amp;storm=top-video">ELK for Logs &amp; Metrics: Video</a></li>
                      </ul>
                    </div>
                  </div>
                </div>
              </div>
            </div>
          </section>

        </div>


<div id="elastic-footer"></div>
<script src="https://www.elastic.co/elastic-footer.js"></script>
<!-- Footer Section end-->

      </section>
    </div>

<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
  window.initial_state = {}</script>
  </body>
</html>
